/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.annotation;

import java.lang.annotation.*;

/**
 * Esta anotação é utilizada para criação de paineis que mostrarão os valores
 * dos atributos de uma entidade, com a possíbilidade de mostrar também os
 * valores de atributos de entidades associadas.<br>
 * O painel pode ser utilizado para apenas mostrar os valores dos atributos, ou
 * também edita-los.<br>
 * <br>
 * Os Valores definidos nesta anotação são utilzados na construção do grid.
 * 
 * @author Glauco
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Panel {

    /**
     * Representa os nomes para construção deste painel. Serão incluidos neste
     * painel os atributos com que possuem um alias igual definido aqui.
     *
     * @return Retorna um array de nomes para esta definição de um painel.
     */
    public String[] alias() default "";

    /**
     * Título do painel.
     * @return
     */
    public String title() default "";

    /**
     * Tipo de vizualização do painel.<br>
     * Por padrão o tipo é de um painel único.<br>
     * <br>
     * Se o tipo não for de um painel único, é necessário informar os paineis
     * associados.
     * @return
     */
    public PanelType type() default PanelType.SINGLE;

    /**
     * Aqui são informados os alias dos paineis associados a este.<br>
     * Estas definições deverão ser feitas apenas se o tipo deste painel é
     * diferente de <code>PanelType.SINGLE</code>.<br>
     * Os paineis associados serão utilizados para construção deste painel.<br>
     * Não se pode associar o painel a ele mesmo, ou seja, os nomes presentes
     * aqui devem ser diferentes dos nomes dos alias definidos para este painel.
     */
    public String[] associatedPanels() default {};
}
